home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 5 / Skunkware 5.iso / man / man.n / open.n < prev    next >
Text File  |  1995-07-17  |  9KB  |  320 lines
  1. '\"
  2. '\" Copyright (c) 1993 The Regents of the University of California.
  3. '\" All rights reserved.
  4. '\"
  5. '\" Permission is hereby granted, without written agreement and without
  6. '\" license or royalty fees, to use, copy, modify, and distribute this
  7. '\" documentation for any purpose, provided that the above copyright
  8. '\" notice and the following two paragraphs appear in all copies.
  9. '\"
  10. '\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
  11. '\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  12. '\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
  13. '\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14. '\"
  15. '\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  16. '\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  17. '\" AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  18. '\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
  19. '\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  20. '\" 
  21. '\" $Header: /user6/ouster/tcl/man/RCS/open.n,v 1.1 93/05/10 17:10:32 ouster Exp $ SPRITE (Berkeley)
  22. '\" 
  23. .\" The definitions below are for supplemental macros used in Tcl/Tk
  24. .\" manual entries.
  25. .\"
  26. .\" .HS name section [date [version]]
  27. .\"    Replacement for .TH in other man pages.  See below for valid
  28. .\"    section names.
  29. .\"
  30. .\" .AP type name in/out [indent]
  31. .\"    Start paragraph describing an argument to a library procedure.
  32. .\"    type is type of argument (int, etc.), in/out is either "in", "out",
  33. .\"    or "in/out" to describe whether procedure reads or modifies arg,
  34. .\"    and indent is equivalent to second arg of .IP (shouldn't ever be
  35. .\"    needed;  use .AS below instead)
  36. .\"
  37. .\" .AS [type [name]]
  38. .\"    Give maximum sizes of arguments for setting tab stops.  Type and
  39. .\"    name are examples of largest possible arguments that will be passed
  40. .\"    to .AP later.  If args are omitted, default tab stops are used.
  41. .\"
  42. .\" .BS
  43. .\"    Start box enclosure.  From here until next .BE, everything will be
  44. .\"    enclosed in one large box.
  45. .\"
  46. .\" .BE
  47. .\"    End of box enclosure.
  48. .\"
  49. .\" .VS
  50. .\"    Begin vertical sidebar, for use in marking newly-changed parts
  51. .\"    of man pages.
  52. .\"
  53. .\" .VE
  54. .\"    End of vertical sidebar.
  55. .\"
  56. .\" .DS
  57. .\"    Begin an indented unfilled display.
  58. .\"
  59. .\" .DE
  60. .\"    End of indented unfilled display.
  61. .\"
  62. '\"    # Heading for Tcl/Tk man pages
  63. .de HS
  64. .ds ^3 \\0
  65. .if !"\\$3"" .ds ^3 \\$3
  66. .if '\\$2'cmds'       .TH \\$1 1 \\*(^3 \\$4
  67. .if '\\$2'lib'        .TH \\$1 3 \\*(^3 \\$4
  68. .if '\\$2'tcl'        .TH \\$1 n \\*(^3 Tcl "Tcl Built-In Commands"
  69. .if '\\$2'tk'         .TH \\$1 n \\*(^3 Tk "Tk Commands"
  70. .if '\\$2'tclc'        .TH \\$1 3 \\*(^3 Tcl "Tcl Library Procedures"
  71. .if '\\$2'tkc'         .TH \\$1 3 \\*(^3 Tk "Tk Library Procedures"
  72. .if '\\$2'tclcmds'         .TH \\$1 1 \\*(^3 Tk "Tcl Applications"
  73. .if '\\$2'tkcmds'         .TH \\$1 1 \\*(^3 Tk "Tk Applications"
  74. .if t .wh -1.3i ^B
  75. .nr ^l \\n(.l
  76. .ad b
  77. ..
  78. '\"    # Start an argument description
  79. .de AP
  80. .ie !"\\$4"" .TP \\$4
  81. .el \{\
  82. .   ie !"\\$2"" .TP \\n()Cu
  83. .   el          .TP 15
  84. .\}
  85. .ie !"\\$3"" \{\
  86. .ta \\n()Au \\n()Bu
  87. \&\\$1    \\fI\\$2\\fP    (\\$3)
  88. .\".b
  89. .\}
  90. .el \{\
  91. .br
  92. .ie !"\\$2"" \{\
  93. \&\\$1    \\fI\\$2\\fP
  94. .\}
  95. .el \{\
  96. \&\\fI\\$1\\fP
  97. .\}
  98. .\}
  99. ..
  100. '\"    # define tabbing values for .AP
  101. .de AS
  102. .nr )A 10n
  103. .if !"\\$1"" .nr )A \\w'\\$1'u+3n
  104. .nr )B \\n()Au+15n
  105. .\"
  106. .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
  107. .nr )C \\n()Bu+\\w'(in/out)'u+2n
  108. ..
  109. '\"    # BS - start boxed text
  110. '\"    # ^y = starting y location
  111. '\"    # ^b = 1
  112. .de BS
  113. .br
  114. .mk ^y
  115. .nr ^b 1u
  116. .if n .nf
  117. .if n .ti 0
  118. .if n \l'\\n(.lu\(ul'
  119. .if n .fi
  120. ..
  121. '\"    # BE - end boxed text (draw box now)
  122. .de BE
  123. .nf
  124. .ti 0
  125. .mk ^t
  126. .ie n \l'\\n(^lu\(ul'
  127. .el \{\
  128. .\"    Draw four-sided box normally, but don't draw top of
  129. .\"    box if the box started on an earlier page.
  130. .ie !\\n(^b-1 \{\
  131. \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  132. .\}
  133. .el \}\
  134. \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  135. .\}
  136. .\}
  137. .fi
  138. .br
  139. .nr ^b 0
  140. ..
  141. '\"    # VS - start vertical sidebar
  142. '\"    # ^Y = starting y location
  143. '\"    # ^v = 1 (for troff;  for nroff this doesn't matter)
  144. .de VS
  145. .mk ^Y
  146. .ie n 'mc \s12\(br\s0
  147. .el .nr ^v 1u
  148. ..
  149. '\"    # VE - end of vertical sidebar
  150. .de VE
  151. .ie n 'mc
  152. .el \{\
  153. .ev 2
  154. .nf
  155. .ti 0
  156. .mk ^t
  157. \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
  158. .sp -1
  159. .fi
  160. .ev
  161. .\}
  162. .nr ^v 0
  163. ..
  164. '\"    # Special macro to handle page bottom:  finish off current
  165. '\"    # box/sidebar if in box/sidebar mode, then invoked standard
  166. '\"    # page bottom macro.
  167. .de ^B
  168. .ev 2
  169. 'ti 0
  170. 'nf
  171. .mk ^t
  172. .if \\n(^b \{\
  173. .\"    Draw three-sided box if this is the box's first page,
  174. .\"    draw two sides but no top otherwise.
  175. .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  176. .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  177. .\}
  178. .if \\n(^v \{\
  179. .nr ^x \\n(^tu+1v-\\n(^Yu
  180. \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
  181. .\}
  182. .bp
  183. 'fi
  184. .ev
  185. .if \\n(^b \{\
  186. .mk ^y
  187. .nr ^b 2
  188. .\}
  189. .if \\n(^v \{\
  190. .mk ^Y
  191. .\}
  192. ..
  193. '\"    # DS - begin display
  194. .de DS
  195. .RS
  196. .nf
  197. .sp
  198. ..
  199. '\"    # DE - end display
  200. .de DE
  201. .fi
  202. .RE
  203. .sp .5
  204. ..
  205. .HS open tcl 7.0
  206. .BS
  207. '\" Note:  do not modify the .SH NAME line immediately below!
  208. .SH NAME
  209. open \- Open a file
  210. .SH SYNOPSIS
  211. .VS
  212. \fBopen \fIfileName\fR ?\fIaccess\fR? ?\fIpermissions\fR?
  213. .VE
  214. .BE
  215.  
  216. .SH DESCRIPTION
  217. .PP
  218. This command opens a file and returns an identifier
  219. that may be used in future invocations
  220. of commands like \fBread\fR, \fBputs\fR, and \fBclose\fR.
  221. \fIFileName\fR gives the name of the file to open; if it starts with
  222. a tilde then tilde substitution is performed as described for
  223. \fBTcl_TildeSubst\fR.
  224. If the first character of \fIfileName\fR is ``|'' then the
  225. remaining characters of \fIfileName\fR are treated as a command
  226. pipeline to invoke, in the same style as for \fBexec\fR.
  227. In this case, the identifier returned by \fBopen\fR may be used
  228. to write to the command's input pipe or read from its output pipe.
  229. .PP
  230. The \fIaccess\fR argument indicates the way in which the file
  231. (or command pipeline) is to be accessed.
  232. .VS
  233. It may take two forms, either a string in the form that would be
  234. passed to the \fBfopen\fR library procedure or a list of POSIX
  235. access flags.
  236. It defaults to ``\fBr\fR''.
  237. In the first form \fIaccess\fR may have any of the following values:
  238. .VE
  239. .TP 15
  240. \fBr\fR
  241. Open the file for reading only; the file must already exist.
  242. .TP 15
  243. \fBr+\fR
  244. Open the file for both reading and writing; the file must
  245. already exist.
  246. .TP 15
  247. \fBw\fR
  248. Open the file for writing only.  Truncate it if it exists.  If it doesn't
  249. exist, create a new file.
  250. .TP 15
  251. \fBw+\fR
  252. Open the file for reading and writing.  Truncate it if it exists.
  253. If it doesn't exist, create a new file.
  254. .TP 15
  255. \fBa\fR
  256. Open the file for writing only.  The file must already exist, and the file
  257. is positioned so that new data is appended to the file.
  258. .TP 15
  259. \fBa+\fR
  260. Open the file for reading and writing.  If the file doesn't exist,
  261. create a new empty file.
  262. Set the initial access position  to the end of the file.
  263. .PP
  264. In the second form, \fIaccess\fR consists of a list of any of the
  265. .VS
  266. following flags, all of which have the standard POSIX meanings.
  267. One of the flags must be either \fBRDONLY\fR, \fBWRONLY\fR or \fBRDWR\fR.
  268. .TP 15
  269. \fBRDONLY\fR
  270. Open the file for reading only.
  271. .TP 15
  272. \fBWRONLY\fR
  273. Open the file for writing only.
  274. .TP 15
  275. \fBRDWR\fR
  276. Open the file for both reading and writing.
  277. .TP 15
  278. \fBAPPEND\fR
  279. Set the file pointer to the end of the file prior to each write.
  280. .TP 15
  281. \fBCREAT\fR
  282. Create the file if it doesn't already exist (without this flag it
  283. is an error for the file not to exist).
  284. .TP 15
  285. \fBEXCL\fR
  286. If \fBCREAT\fR is specified also, an error is returned if the
  287. file already exists.
  288. .TP 15
  289. \fBNOCTTY\fR
  290. If the file is a terminal device, this flag prevents the file from
  291. becoming the controlling terminal of the process.
  292. .TP 15
  293. \fBNONBLOCK\fR
  294. Prevents the process from blocking while opening the file.
  295. For details refer to your system documentation on the \fBopen\fR system
  296. call's \fBO_NONBLOCK\fR flag.
  297. .TP 15
  298. \fBTRUNC\fR
  299. If the file exists it is truncated to zero length.
  300. .PP
  301. If a new file is created as part of opening it, \fIpermissions\fR
  302. (an integer) is used to set the permissions for the new file in
  303. conjunction with the process's file mode creation mask.
  304. \fIPermissions\fR defaults to 0666.
  305. .VE
  306. .PP
  307. If a file is opened for both reading and writing then \fBseek\fR
  308. must be invoked between a read and a write, or vice versa (this
  309. restriction does not apply to command pipelines opened with \fBopen\fR).
  310. When \fIfileName\fR specifies a command pipeline and a write-only access
  311. is used, then standard output from the pipeline is directed to the
  312. current standard output unless overridden by the command.
  313. When \fIfileName\fR specifies a command pipeline and a read-only access
  314. is used, then standard input from the pipeline is taken from the
  315. current standard input unless overridden by the command.
  316.  
  317. .SH KEYWORDS
  318. access mode, append, controlling terminal, create, file,
  319. non-blocking, open, permissions, pipeline, process
  320.